<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UDisks2.Partition: UDisks Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="UDisks Reference Manual">
<link rel="up" href="ch02.html" title="D-Bus Interfaces">
<link rel="prev" href="gdbus-org.freedesktop.UDisks2.Block.html" title="org.freedesktop.UDisks2.Block">
<link rel="next" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html" title="org.freedesktop.UDisks2.PartitionTable">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Partition.description" class="shortcut">Description</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#gdbus-org.freedesktop.UDisks2.Partition.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdbus-org.freedesktop.UDisks2.Block.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdbus-org.freedesktop.UDisks2.Partition"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdbus-interface-org-freedesktop-UDisks2-Partition.top_of_page"></a>org.freedesktop.UDisks2.Partition</span></h2>
<p>org.freedesktop.UDisks2.Partition — Block device representing a partition</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetType" title="The SetType() method">SetType</a>  (IN  s     type,
          IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetName" title="The SetName() method">SetName</a>  (IN  s     name,
          IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.SetFlags" title="The SetFlags() method">SetFlags</a> (IN  t     flags,
          IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.Resize" title="The Resize() method">Resize</a>   (IN  t     size,
          IN  a{sv} options);
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-method-org-freedesktop-UDisks2-Partition.Delete" title="The Delete() method">Delete</a>   (IN  a{sv} options);
</pre>
</div>
<div class="refsect1">
<a name="id-1.3.3.7.4"></a><h2>Properties</h2>
<pre class="synopsis">
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Number" title='The "Number" property'>Number</a>       readable   u
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>Type</a>         readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Flags" title='The "Flags" property'>Flags</a>        readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Offset" title='The "Offset" property'>Offset</a>       readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Size" title='The "Size" property'>Size</a>         readable   t
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Name" title='The "Name" property'>Name</a>         readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.UUID" title='The "UUID" property'>UUID</a>         readable   s
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Table" title='The "Table" property'>Table</a>        readable   o
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer" title='The "IsContainer" property'>IsContainer</a>  readable   b
<a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContained" title='The "IsContained" property'>IsContained</a>  readable   b
</pre>
</div>
<div class="refsect1">
<a name="gdbus-interface-org-freedesktop-UDisks2-Partition"></a><h2>Description</h2>
<p>      This interface is used for <a class="link" href="gdbus-org.freedesktop.UDisks2.Block.html#gdbus-interface-org-freedesktop-UDisks2-Block.top_of_page">org.freedesktop.UDisks2.Block</a>
      devices that represent entries in a partition table.
</p>
</div>
<div class="refsect1">
<a name="gdbus-methods-org.freedesktop.UDisks2.Partition"></a><h2>Method Details</h2>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetType"></a><h3>The SetType() method</h3>
<pre class="programlisting">
SetType (IN  s     type,
         IN  a{sv} options);
</pre>
<p>         Sets the partition type. See the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Type" title='The "Type" property'>"Type"</a> property for a
         description of known partition types.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>type</code></em></code>:</span></p></td>
<td><p>New type to set.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetName"></a><h3>The SetName() method</h3>
<pre class="programlisting">
SetName (IN  s     name,
         IN  a{sv} options);
</pre>
<p>         Sets the partition name.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN s <em class="parameter"><code>name</code></em></code>:</span></p></td>
<td><p>New name to set.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.SetFlags"></a><h3>The SetFlags() method</h3>
<pre class="programlisting">
SetFlags (IN  t     flags,
          IN  a{sv} options);
</pre>
<p>         Sets the partition flags. See the
         <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.Flags" title='The "Flags" property'>"Flags"</a> property for a
         description of known flags.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>flags</code></em></code>:</span></p></td>
<td><p>New flags to set.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options (currently unused except for <a class="link" href="udisks-std-options.html" title="The options parameter">standard options</a>).</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.Resize"></a><h3>The Resize() method</h3>
<pre class="programlisting">
Resize (IN  t     size,
        IN  a{sv} options);
</pre>
<p>         <em class="parameter"><code>since</code></em> 2.7.2
</p>
<p>         Resizes the partition.
</p>
<p>         The partiton will not change its position but might be slightly bigger
         than requested due to sector counts and alignment (e.g. 1MiB).
         If the requested size can't be allocated it results in an error.
         The maximal size can automatically be set by using 0 as size.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><code class="literal">IN t <em class="parameter"><code>size</code></em></code>:</span></p></td>
<td><p>New partition size in bytes, 0 for maximal size.</p></td>
</tr>
<tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options.</p></td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-method-org-freedesktop-UDisks2-Partition.Delete"></a><h3>The Delete() method</h3>
<pre class="programlisting">
Delete (IN  a{sv} options);
</pre>
<p>         Deletes the partition.
</p>
<p>         If the option <em class="parameter"><code>tear-down</code></em> is set to
         <code class="constant">TRUE</code>, then the block device and all its children will be
         cleaned up before formatting.  This cleanup consists of
         removing entries from /etc/fstab and /etc/crypttab, and
         locking of encrypted block devices.  Entries in /etc/fstab
         and /etc/crypttab that have been created with the
         'track-parents' options to AddConfigurationItem will be
         removed even if their block device is currently unavailable.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><code class="literal">IN a{sv} <em class="parameter"><code>options</code></em></code>:</span></p></td>
<td><p>Options.</p></td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="gdbus-properties-org.freedesktop.UDisks2.Partition"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Number"></a><h3>The "Number" property</h3>
<pre class="programlisting">
Number  readable   u
</pre>
<p>The number of the partition in the partition table.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Type"></a><h3>The "Type" property</h3>
<pre class="programlisting">
Type  readable   s
</pre>
<p>The type of the partition.</p>
<p>         For <code class="literal">dos</code> partition tables, this string is a
         hexadecimal number e.g. <code class="literal">0x83</code> or
         <code class="literal">0xfd</code>. For <code class="literal">gpt</code> partition
         tables this is the UUID
         e.g. <code class="literal">ebd0a0a2-b9e5-4433-87c0-68b6b72699c7</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Flags"></a><h3>The "Flags" property</h3>
<pre class="programlisting">
Flags  readable   t
</pre>
<p>Flags describing the partition.</p>
<p>         Known flags for <code class="literal">dos</code> partitions include:
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term">Bit 7</span></p></td>
<td><p>The partition is marked as bootable</p></td>
</tr></tbody>
</table></div>
<p>
         Known flags for <code class="literal">gpt</code> partitions include:
         </p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">Bit 0</span></p></td>
<td><p>System partition</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 2</span></p></td>
<td><p>Legacy BIOS Bootable</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 60</span></p></td>
<td><p>Read-only</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 62</span></p></td>
<td><p>Hidden</p></td>
</tr>
<tr>
<td><p><span class="term">Bit 63</span></p></td>
<td><p>Do not automount</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Offset"></a><h3>The "Offset" property</h3>
<pre class="programlisting">
Offset  readable   t
</pre>
<p>Offset of partition, in bytes.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Size"></a><h3>The "Size" property</h3>
<pre class="programlisting">
Size  readable   t
</pre>
<p>Size of partition, in bytes.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Name"></a><h3>The "Name" property</h3>
<pre class="programlisting">
Name  readable   s
</pre>
<p>Label of partition or blank if not supported or unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.UUID"></a><h3>The "UUID" property</h3>
<pre class="programlisting">
UUID  readable   s
</pre>
<p>The UUID of the partition or blank if not supported or unknown.</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.Table"></a><h3>The "Table" property</h3>
<pre class="programlisting">
Table  readable   o
</pre>
<p>         The object path of the <a class="link" href="gdbus-org.freedesktop.UDisks2.PartitionTable.html#gdbus-interface-org-freedesktop-UDisks2-PartitionTable.top_of_page">org.freedesktop.UDisks2.PartitionTable</a>
         object that the partition entry belongs to.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer"></a><h3>The "IsContainer" property</h3>
<pre class="programlisting">
IsContainer  readable   b
</pre>
<p>         Set to <code class="constant">TRUE</code> if the partition itself is a container for other
         partitions.
</p>
<p>         For example, for <code class="literal">dos</code> partition tables,
         this applies to socalled <span class="emphasis"><em>extended partition</em></span> (partitions of type
         <code class="constant">0x05</code>, <code class="constant">0x0f</code> or <code class="constant">0x85</code>)
         containing socalled <span class="emphasis"><em>logical partitions</em></span>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gdbus-property-org-freedesktop-UDisks2-Partition.IsContained"></a><h3>The "IsContained" property</h3>
<pre class="programlisting">
IsContained  readable   b
</pre>
<p>         Set to <code class="constant">TRUE</code> of the partition is contained in another partition.
         See the <a class="link" href="gdbus-org.freedesktop.UDisks2.Partition.html#gdbus-property-org-freedesktop-UDisks2-Partition.IsContainer" title='The "IsContainer" property'>"IsContainer"</a> property for more information.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>